Development

Documentation for developing this php testing library.

Contributing

TODO (decide on contributor licensing / terms. Give guidance for how to contribute (issue then PR?), how/if contributors are featured)

Writing Documentation

TODO (edit docsrc folder, use links config in scrawl.json, general style/philosophy)

CLI

Tester uses @link(taeluf/cli), but does so with a @see_file(src/Runner.php, custom \Tlf\Cli subclass).

Add a method to @see_file(src/Runner.php, Tlf\Tester\Runner), and add a command to Runner::setup_methods()`, referencing that method. Copy the signature of an existing command.

A command is a <string name, string name of method on the Runner class, string help text>

bin/phptest is the bin script which sets up the Runner. Features should be added to the Runner, not the bin script.

bin/phptest-global is a special bin script that will either call bin/phptest directly, or will call vendor/bin/phptest if inside a different project's git repository.

TODO (write the script!) bin/phptest-own is a special bin script to use when inside THIS repository. Example mkdir temp/; cd temp; within this repo, then use ../bin/phptest-own while inside the temp directory, so that you can test the cli.

The two special scripts exist to simplify setup for the majority of projects, and hopefully simplify the code!